[CLI-332] Add optional HelpFormatter Function to document Deprecated options#271
Merged
garydgregory merged 4 commits intoMay 11, 2024
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #271 +/- ##
============================================
+ Coverage 91.90% 95.83% +3.92%
- Complexity 575 658 +83
============================================
Files 22 23 +1
Lines 1247 1367 +120
Branches 210 226 +16
============================================
+ Hits 1146 1310 +164
+ Misses 63 25 -38
+ Partials 38 32 -6 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| * @param showDeprecatedFunc Specify the format for the deprecated options. | ||
| * @return this. | ||
| */ | ||
| public Builder setShowDeprecated(final BiFunction<String, Option, String> showDeprecatedFunc) { |
Member
There was a problem hiding this comment.
A new public or protected API needs a @since tag, which for semantic versioning would be 1.8.0.
| * | ||
| * @param showDeprecatedFunc Specify the format for the deprecated options. | ||
| * @return this. | ||
| * @since(1.8.0) |
Member
There was a problem hiding this comment.
There are no parens in Javadoc tags, it's not a function call ;-)
asfgit
pushed a commit
that referenced
this pull request
May 11, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implement new feature CLI-332
Added a
BiFunction<String, Object, String>to the HelpFormatter and its Builder. Also tests for same.